TransferLineUri

The TransferLineUri API procedure allows an application to transfer a currently active phone call to a new location as specified by a SIP URI. It is similar in functionality to the TransferLine API procedure.

Parameters:

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

pSipUri

[in] The NULL terminated string specifying the call transfer location as a SIP URI. The basic form of an acceptable SIP URI is sip:user@host:port. At this time the media engine only processes user, host and port of SIP URIs. For a complete description of SIP URIs, please see section 19.1.1 (SIP and SIPS URI Components) of the SIP RFC (RFC3261).

UseSipProxy

[in] If specified as non zero, then the call transfer command will be sent through your configured proxy server regardless of the destination address of the far end of the current phone call. The proxy will then be responsible for forwarding the transfer command to the far end of the current call.

PhoneLine

[in] The zero based telephony engine phone line that will be used to transfer the phone call.

Return Value:

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the TELEPHONY_RETURN_VALUE data type. The TransferLineUri API procedure returns the same values as specified by the TransferLine API procedure in addition to the following return values: